Docs - Starlight Refactoring #929
Conversation
…e built-in version.
…mponent. Able to remove redundant SidebarSublist component.
|
@awhitford is attempting to deploy a commit to the OramaSearch Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@micheleriva Please let me know if you have any questions or concerns about this PR. Once merged, I will revisit the Astro and Starlight upgrade, but this will make things easier. |
|
I'm imaging this plugin will:
Is that right? @awhitford ? |
|
@Saif-Shines This PR simply includes some refactoring of how Starlight is used by Orama's Docs. This PR is helpful because it will then enable me to upgrade to a newer version of Astro and Starlight for Orama Docs. This does not impact Orama's Astro Plugin. However, I would like to make changes to that eventually -- but this PR was meant to be a step in that direction. Still patiently waiting after a month. |
In preparation for a Starlight upgrade, I discovered that there were several opportunities to simplify the custom components and avoid reimplementing built-in component logic so that long term maintenance is easier, and it benefits from future enhancements.
Herocomponent because it did not seem to deviate from the built-in component.Footercomponent to use the built-in component.Sidebarcomponent with a version that leverages the built-in component, and was able to remove the redundantSidebarSubListcomponent.Headercomponent in favor of simply overriding theSearchcomponent. (This maintains the Mobile menu.)TableOfContentscomponent to use the built-in component.There may be some slight cosmetic differences, but hopefully you will agree that this is easier to maintain and sets the project up to benefit from future enhancements, such as the
SidebarPersister.